home *** CD-ROM | disk | FTP | other *** search
/ Aminet 34 / Aminet 34 (2000)(Schatztruhe)[!][Dec 1999].iso / Aminet / util / sys / StringSnip.readme < prev    next >
Encoding:
Text File  |  1999-11-06  |  10.8 KB  |  325 lines
  1. Short:    Much better editing features in string gadgets
  2. Author:   thor@einstein.math.tu-berlin.de (Thomas Richter)
  3. Uploader: thor@einstein.math.tu-berlin.de
  4. Version:  2.04
  5. Type:     util/sys
  6. Requires: Os 2.04, optionally ViNCEd.
  7.  
  8. _____________________________________________________________________________
  9.  
  10. New in release 2.04:
  11.  
  12.     - Due to some unfortune, an internal structure appeared on an odd
  13.       address which caused a crash on 68000 and 68010 based systems.
  14.       Nothing else changed.
  15.  
  16. New in release 2.03:
  17.  
  18.     - Fixed a possible incompatibility of Amiga-V that could have
  19.       resulted in inserting a string twice if the application edit
  20.       hook is able to parse this key as well.
  21.  
  22. New in release 2.02:
  23.  
  24.     - The NumLock function was erraneously bound to Alt-Ü on german
  25.       keyboards. Never thrust a Data-Becker book, especially when
  26.       looking up key-codes.
  27.  
  28. New in release 2.01.1:
  29.  
  30.     - Included a sample preferences file for those people that don't
  31.       read ReadMes. (-;
  32.  
  33. New in release 2.01:
  34.  
  35.     - Almost a complete rewrite, fully configurable with ViNCEd style
  36.       preferences (vnc.library required).
  37.     - Includes now TAB expansions and much more editor commands.
  38. _____________________________________________________________________________
  39.  
  40.  
  41. The following table shows the default configuration for string gadget hooks:
  42.  
  43. Alt+Cursor keys:    Move to beginning of next/previous word
  44. Alt+Ctrl+Cursor keys:    Move to beginning of next/previous path component
  45. Shift+Cursor keys:    Move to start/end of the contents.
  46. Alt+Cursor keys:    ditto.
  47. Alt+Del:        Clear the contents.
  48. Shift+Del:        ditto.
  49. ALT+Backspace:        Erase to the beginning of the word under the cursor
  50. Shift+Alt+Del:        Erase text behind the cursor
  51. Shift+Alt+BS:        Erase text before the cursor position
  52. Amiga+X:        Cut the contents of the gadget to the clipboard
  53. Amiga+C:        Copy the contents to the clipboard
  54. Amiga+V:        Insert the clipboard contents into the gadget
  55. Shift+Amiga+V:        Replace the string gadget contents by the clipboard
  56. Aniga+Q:        Undo-operation
  57. Ctrl+Tab:        TAB expansion
  58. Ctrl+Shift+Tab:        TAB expansion backwards
  59. Commodore-key:        Turn off the extended editing features temporary
  60.  
  61.  
  62. The configuration is, however, fully adjustable with the SetVNC program
  63. of the "ViNCEd" package, see below for details.
  64.  
  65. The TAB expansion is a "cut down" version of the ViNCEd style expansion
  66. mechanism without a double-TAB requester, without the complete command
  67. path search and without a TAB expansion cache.
  68. Please note that string gadget does not come with a "natural" directory the 
  69. TAB expansion should search in, hence the path to be expanded must be either
  70. absolute or relative to the boot volume, i.e. SYS:
  71.  
  72. (This file is actually a part of the ViNCEd distribution. See 
  73. util/shell/ViNCEd.lha for the complete archive).
  74.  
  75.  
  76. Installation:
  77.     Copy to your C: drawer.
  78.  
  79.     StringSnip install    To install the extended editing features
  80.     StringSnip remove    To remove it again.
  81.  
  82. Additionally:    
  83.     Copy the demo prefs file below to ENVARC:StringSnip.prefs and 
  84.     add the line
  85.  
  86.     StringSnip PREFS ENV:StringSnip.prefs INSTALL
  87. _____________________________________________________________________________
  88.  
  89. Extended options, full synopsis:
  90.  
  91. StringSnip INSTALL/S,REMOVE/S,PREFS/K,HELP/S
  92.  
  93.  
  94. INSTALL/S            Installs the enhanced string edit hook
  95.                 or replaces a previously installed 
  96.                 "StringSnip" copy.
  97.                 This is the default operation.
  98.  
  99. REMOVE/S            Remove the StringSnip hook.
  100.  
  101. PREFS/K                Specifies a file name where the preferences
  102.                 should be taken from. This is a text based
  103.                 ViNCEd-compatible preferences file. It
  104.                 should be created by the "SetVNC" program
  105.                 and should be placed somehwere in the ENV:
  106.                 drawer.
  107.                 THIS OPTION REQUIRES the vnc.library, i.e.
  108.                 ViNCEd must have been installed.
  109.  
  110. HELP/S                Prints a tiny overview about the command line
  111.                 options.
  112. _____________________________________________________________________________
  113.  
  114. The preferences file: 
  115.  
  116. It is recommended that you use the "SetVNC" program of the ViNCEd package
  117. to generate this file, as the vnc.library is required anyways to read it.
  118.  
  119. As last resort, an ASCII editor is enough to edit this file, though.
  120.  
  121. The file is a listing of options, followed by an "=" ("equals") sign,
  122. followed by the value you want to set the option to. This must be "on"
  123. or "off" for boolean options, a number for numerical or a key specification
  124. for the keyboard configuration options. Commands must be introduced by a
  125. semicolon.
  126.  
  127. Here's a list of the options that are meaningfull to StringSnip. The lines
  128. below could be cut out and written directly to a file, for example to
  129. ENVARC:StringSnip.prefs.
  130.  
  131. ___________cut here__________________________________________________________
  132.  
  133. WRAP=off        
  134. ;whether the TAB expansion wraps around or not.
  135.  
  136. ;TAB expansion settings:
  137. ;These are priorities how the list of found nodes are sorted and in
  138. ;which order they appear. The list of found matches can be cycled thru
  139. ;with the TAB expansion keys, as in ViNCEd.
  140.  
  141. TAB_FILE_PRI=0        
  142. ;priority of non-executable non-script files
  143. TAB_EXEC_PRI=2        
  144. ;priority of executables.
  145. TAB_SCRIPT_PRI=1    
  146. ;priority of script files.
  147. TAB_INFO_PRI=-10    
  148. ;priority of icons
  149. TAB_DEVICE_PRI=-2    
  150. ;of devices
  151. TAB_ASSIGN_PRI=-2    
  152. ;of assigns (logical devices)
  153. TAB_VOLUME_PRI=-2    
  154. ;of volume names
  155. TAB_DIRECTORY_PRI=3    
  156. ;of directories
  157. TAB_FULLEXPAND=off    
  158. ;should the first TAB expand the file completely?
  159.  
  160.  
  161. ;Keyboard:
  162. ;These are one or more qualifiers, i.e.
  163. ; Alt, Shift for either shift or alt key, RAmiga, LAmiga, RShift, LShift,
  164. ; RAlt, RAlt for the right/left modifier keys, "Num" if numlock is "on".
  165. ; The numlock is a special modifier that is toggled by an additional key
  166. ; to be set up here, it is completely unrelated to the "numeric keypad"
  167. ;and a key name, as "Left" "Right" for the cursor keys or
  168. ;a keyboard code, or an ASCII value enclosed in single quotes if the
  169. ;key should be matched on an ASCII string and not on a physical key.
  170. ;Details about this again in the ViNCEd guide.
  171. ;
  172. CURSOR_LEFT=Left
  173. CURSOR_RIGHT=Right        
  174. ;guess what...
  175. HALF_SCREEN_LEFT=Shift Left    
  176. ;moves one string gadget width
  177. HALF_SCREEN_RIGHT=Shift Right    
  178. ;to the left/right (not used by default)
  179. TO_LEFT_BORDER=Ctrl Left
  180. TO_RIGHT_BORDER=Ctrl Right    
  181. ;moves to the boundary
  182. PREV_WORD=Alt Left
  183. NEXT_WORD=Alt Right        
  184. ;moves word-wise
  185. PREV_COMPONENT=Ctrl Alt Left
  186. NEXT_COMPONENT=Ctrl Alt Right    
  187. ;moves path-component-wise
  188. CURSOR_LEFT=Num Num4
  189. CURSOR_RIGHT=Num Num6        
  190. ;more than one definition is allowed!
  191. TO_LEFT_BORDER=Ctrl Left
  192. TO_RIGHT_BORDER=Ctrl Right
  193. SEND_INPUTS=Return        
  194. ;completes the input
  195. INSERT_^J=Shift Alt Return    
  196. ;inserts a Ctrl-J.
  197. TAB_FORWARDS=Tab
  198. TAB_BACKWARDS=Shift Tab        
  199. ;TAB cycling
  200. EXPAND_PATH=Ctrl Tab
  201. EXPAND_BACKWARDS=Ctrl Shift Tab    
  202. ;TAB expansion
  203. DELETE_FORWARDS=Del        
  204. ;the "Delete" function
  205. DELETE_BACKWARDS=Backspace    
  206. ;the "Backspace" function
  207. DELETE_FULL_LINE=Shift Del    
  208. ;delete all
  209. DELETE_WORD_FWDS=Shift Backspace
  210. DELETE_WORD_BKWDS=Alt Backspace    
  211. ;one word, backwards
  212. DELETE_COMPONENT_FWDS=Ctrl Alt Del
  213. DELETE_COMPONENT_BKWDS=Ctrl Alt Backspace
  214. DELETE_END_OF_LINE=Shift Alt Del
  215. DELETE_START_OF_LINE=Shift Alt Backspace
  216. ;the next are the standard clipboard functions
  217. CUT=RAmiga x            
  218. COPY=RAmiga c
  219. PASTE=RAmiga v
  220. TOGGLE_NUMLOCK=Alt Num[        
  221. ;Num[ is the '[' key on the numpad, this toggles the NumLock qualifier.
  222. YANK=RAmiga q            
  223. ;this is the intuition style "undo"
  224. HELP=Help            
  225. ;the HELP function, if used by the program
  226. INSERT_CSI=Alt Esc        
  227. ;inserts 0x9B
  228. INSERT_ESC=Shift Esc        
  229. ;inserts 0x1B
  230.  
  231. _____________________________________________________________________________
  232.  
  233.                          The THOR-Software Licence (v2, 24th June 1998)
  234.  
  235.  
  236. This License applies to the computer program known as "StringSnip".
  237. The "Program", below, refers to such program. The "Archive" refers to the 
  238. package of distribution, as prepared by the author of the Program, 
  239. Thomas Richter. Each licensee is addressed as "you".
  240.  
  241.  
  242.  
  243. The Program and the data in the archive are freely distributable
  244. under the restrictions stated below, but are also Copyright (c)
  245. Thomas Richter.
  246.  
  247. Distribution of the Program, the Archive and the data in the Archive by a
  248. commercial organization without written permission from the author to any
  249. third party is prohibited if any payment is made in connection with such
  250. distribution, whether directly (as in payment for a copy of the Program) or
  251. indirectly (as in payment for some service related to the Program, or
  252. payment for some product or service that includes a copy of the Program
  253. "without charge"; these are only examples, and not an exhaustive enumeration
  254. of prohibited activities).
  255.  
  256.  
  257. However, the following methods of distribution
  258. involving payment shall not in and of themselves be a violation of this
  259. restriction:
  260.  
  261.  
  262. (i) Posting the Program on a public access information storage and
  263. retrieval service for which a fee is received for retrieving information
  264. (such as an on-line service), provided that the fee is not
  265. content-dependent (i.e., the fee would be the same for retrieving the same
  266. volume of information consisting of random data).
  267.  
  268.  
  269. (ii) Distributing the Program on a CD-ROM, provided that
  270.  
  271. a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
  272. especially this licence agreement;
  273.  
  274. b) the CD-ROM is made available to the public for a nominal fee only,
  275.  
  276. c) a copy of the CD is made available to the author for free except for
  277. shipment costs, and
  278.  
  279. d) provided further that all information on such CD-ROM is redistributable
  280. for non-commercial purposes without charge.
  281.  
  282.  
  283. Redistribution of a modified version of the Archive, the Program or the
  284. contents of the Archive is prohibited in any way, by any organization,
  285. regardless whether commercial or non-commercial. Everything must be kept
  286. together, in original and unmodified form.
  287.  
  288.  
  289.  
  290.  
  291. Limitations.
  292.  
  293.  
  294. THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
  295. WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  296. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  297. PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
  298. RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
  299. THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  300. SERVICING, REPAIR OR CORRECTION.
  301.  
  302.  
  303. IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
  304. AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
  305. LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.
  306.  
  307.  
  308.                                                         Thomas Richter
  309.  
  310. _____________________________________________________________________________
  311.  
  312. Thomas,
  313.     October 1999
  314.  
  315.  
  316. ============================= Archive contents =============================
  317.  
  318. Original  Packed Ratio    Date     Time    Name
  319. -------- ------- ----- --------- --------  -------------
  320.     9740    5888 39.5% 16-Oct-99 17:20:32 +StringSnip
  321.     2981    1426 52.1% 23-Jan-99 18:44:30 +StringSnip.prefs
  322.    10579    4433 58.0% 16-Oct-99 17:25:12 +StringSnip.readme
  323. -------- ------- ----- --------- --------
  324.    23300   11747 49.5% 21-Oct-99 20:59:16   3 files
  325.